home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Source Code / C / Applications / UIFlow 1.0.1 / UIFlow Source / VSet2.0 / Src / vg.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-03-06  |  9.7 KB  |  318 lines  |  [TEXT/????]
  1. /*****************************************************************************
  2. * 
  3. *              NCSA HDF Vset release 2.1
  4. *                    May 1991
  5. *
  6. * NCSA HDF Vset release 2.1 source code and documentation are in the public
  7. * domain.  Specifically, we give to the public domain all rights for future
  8. * licensing of the source code, all resale rights, and all publishing rights.
  9. * 
  10. * We ask, but do not require, that the following message be included in all
  11. * derived works:
  12. * 
  13. * Portions developed at the National Center for Supercomputing Applications at
  14. * the University of Illinois at Urbana-Champaign.
  15. * 
  16. * THE UNIVERSITY OF ILLINOIS GIVES NO WARRANTY, EXPRESSED OR IMPLIED, FOR THE
  17. * SOFTWARE AND/OR DOCUMENTATION PROVIDED, INCLUDING, WITHOUT LIMITATION,
  18. * WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE
  19. * 
  20. *****************************************************************************
  21. *  Likkai Ng MAY 91  NCSA
  22. * 
  23. * vg.h
  24. * Part of HDF VSet interface
  25. *
  26. * defines symbols and structures used in all v*.c files    
  27. *
  28. * NOTES:
  29. * This include file depends on the basic HDF *.h files dfi.h and df.h.
  30. * An 'S' in the comment means that that data field is saved in the HDF file.
  31. *
  32. ******************************************************************************/
  33.  
  34.  
  35. #include <df.h>
  36.  
  37. #define PUBLIC        
  38. #define PRIVATE    static
  39.  
  40.  
  41.  
  42. /* 
  43. * interlacing supported by the vset. 
  44. */
  45.  
  46. #define FULL_INTERLACE    0
  47. #define NO_INTERLACE        1
  48.  
  49. /* 
  50. * some max lengths 
  51. *
  52. * Except for FIELDNAMELENMAX, change these as you please, they 
  53. * affect memory only, not the file. 
  54. *
  55. */
  56.  
  57. #define FIELDNAMELENMAX    16                /* fieldname   : 16 chars max */
  58.  
  59. #define VSFIELDMAX        20              /* max no of fields per vdata */
  60. #define VSNAMELENMAX        64                /* vdata name  : 64 chars max */    
  61. #define VGNAMELENMAX        64                /* vgroup name : 64 chars max */    
  62. #define VFILEMAX             40             /* max no of files that may be opened */
  63. /* actually, for now, this is the max # of file units that can be used */
  64.  
  65.  
  66. /*
  67. * definition of the 2 data elements of the vset.
  68. */
  69.  
  70. typedef struct vgroup_desc         VGROUP;
  71. typedef struct vdata_desc            VDATA;
  72.  
  73. typedef VDATA VSUBGROUP;
  74.  
  75.  
  76. /*
  77. * -----------------------------------------------------------------
  78. * structures that are part of the VDATA structure
  79. * -----------------------------------------------------------------
  80. */
  81.  
  82. typedef struct symdef_struct 
  83. {
  84.     char* name;                        /* symbol name */
  85.     int    type;                        /* whether int, char, float etc */
  86.     int    isize;                    /* field size as stored in vdata */
  87.     int    order;                    /* order of field */
  88.  
  89.     } SYMDEF;
  90.  
  91. typedef struct write_struct    
  92. {
  93.     int32    n;                            /* S actual # fields in element */
  94.     int    ivsize;                    /* S size of element as stored in vdata */
  95.      char     name[VSFIELDMAX][FIELDNAMELENMAX+1];
  96.                                         /* S name of each field */
  97.     int    len[VSFIELDMAX];         /* S length of each fieldname */
  98.     int    type[VSFIELDMAX];        /* S field type */
  99.       int    off[VSFIELDMAX];        /* S field offset in element in vdata */
  100.       int     isize[VSFIELDMAX];    /* S internal (HDF) size [incl order] */
  101.       int    order[VSFIELDMAX];    /* S order of field */
  102.       int    esize[VSFIELDMAX];    /*  external (local machine) size [incl order] */
  103.     int    (*toIEEEfn  [VSFIELDMAX] )();
  104.     int    (*fromIEEEfn[VSFIELDMAX] )();
  105.  
  106.       }         VWRITELIST;
  107.  
  108. typedef struct read_struct
  109. {
  110.     int    n;                         /* # fields to read */
  111.     int    item[VSFIELDMAX];     /* index into vftable_struct */
  112.  
  113.     } VREADLIST;
  114.  
  115. /* 
  116. *  ----------------------------------------------- 
  117.         V G R O U P     definition     
  118. *  ----------------------------------------------- 
  119. */
  120.  
  121. #define MAXNVELT  36                /* max no of elements in a vgroup */
  122.  
  123. struct vgroup_desc
  124. { 
  125.     int    otag, oref;            /* tag-ref of this vgroup */
  126.       DF         *f;                          /* HDF file ptr */
  127.     int16     nvelt;                     /* S no of elements */
  128.       int     access;                    /* 'r' or 'w' */
  129.     int     tag[MAXNVELT];        /* S tag of element */
  130.     int     ref[MAXNVELT];        /* S ref of element */
  131.      char     vgname[VGNAMELENMAX+1];/* S name of this vgroup */
  132.      char     vgclass[VGNAMELENMAX+1];/*  class name of this vgroup */
  133.     VDATA* velt[MAXNVELT];         /* pts to a element if opened; or else NULL */
  134.     int    marked;                    /* =1 if new info has been added to vgroup */
  135.     int16        extag, exref;            /* expansion tag-ref */
  136.     int16        version, more;            /* version and "more" field */    
  137.  
  138.     };                                    /* VGROUP */
  139.  
  140. /*
  141. *  ----------------------------------------------- 
  142. *         V D A T A      definition   
  143. *  ----------------------------------------------- 
  144. */
  145.  
  146. #define USYMMAX 36                /* max user-defined symbols allowed */
  147.  
  148. struct vdata_desc{ 
  149.       int    otag, oref;             /* tag,ref of this vdata */
  150.       DF        *f;                          /* HDF file ptr */
  151.       int    access;                    /* 'r' or 'w' */
  152.      char    vsname[VSNAMELENMAX+1];/* S name of this vdata */
  153.      char    vsclass[VSNAMELENMAX+1];/* class name of this vdata */
  154.       int    interlace;                /* S  interlace as in file */
  155.       int32    nvertices;                /* S  #vertices in this vdata */
  156.     int    vpos;                    /* cur position (in terms of elements) */
  157.     VWRITELIST    wlist;
  158.       VREADLIST    rlist;
  159.     int              nusym;
  160.     SYMDEF         usym[USYMMAX];
  161.     int    marked;                    /* =1 if new info has been added to vdata */
  162.  
  163.     int16        extag, exref;            /* expansion tag-ref */
  164.     int16        version, more;            /* version and "more" field */    
  165.  
  166.       };                                  /* VDATA */ 
  167.  
  168. /* MACROS - Use these for accessing field components of vdata. */
  169.  
  170. #define VFnfields(vdata)         (vdata->wlist.n)
  171. #define VFfieldname(vdata,t)     (vdata->wlist.name[t])
  172. #define VFfieldtype(vdata,t)     (vdata->wlist.type[t])
  173. #define VFfieldisize(vdata,t)     (vdata->wlist.isize[t])
  174. #define VFfieldesize(vdata,t)     (vdata->wlist.esize[t])
  175. #define VFfieldorder(vdata,t)     (vdata->wlist.order[t])
  176.  
  177.  
  178. /* --------------  H D F    V S E T   tags  ---------------------------- */
  179.  
  180. #define OLD_VGDESCTAG      61820        /* tag for a vgroup d*/ 
  181. #define OLD_VSDESCTAG     61821        /* tag for a vdata descriptor */
  182. #define OLD_VSDATATAG     61822        /* tag for actual raw data of a vdata */ 
  183.  
  184. #define NEW_VGDESCTAG    1965
  185. #define NEW_VSDESCTAG    1962
  186. #define NEW_VSDATATAG    1963
  187.  
  188. #define VGDESCTAG         NEW_VGDESCTAG 
  189. #define VSDESCTAG         NEW_VSDESCTAG 
  190. #define VSDATATAG          NEW_VSDATATAG 
  191.  
  192. /*
  193. * Actual sizes of data types stored in HDF file, and are IEEE-defined. 
  194. */
  195.  
  196. #define IEEE_UNTYPEDSIZE   0
  197. #define IEEE_CHARSIZE      1
  198. #define IEEE_INT16SIZE     2
  199. #define IEEE_INT32SIZE     4
  200. #define IEEE_FLOATSIZE     4
  201.  
  202. /*
  203. * types used in defining a new field via a call to VSfdefine
  204. */
  205.  
  206. #define LOCAL_NOTYPE            0
  207. #define LOCAL_CHARTYPE      1
  208. #define LOCAL_INTTYPE          2
  209. #define LOCAL_FLOATTYPE        3
  210. #define LOCAL_LONGTYPE          4
  211.  
  212. /*
  213. * actual LOCAL MACHINE sizes of the above types
  214. */
  215.  
  216. #define LOCAL_UNTYPEDSIZE  0
  217. #define LOCAL_CHARSIZE      sizeof(unsigned char)
  218. #define LOCAL_INTSIZE          sizeof(int)
  219. #define LOCAL_LONGSIZE         sizeof(long)
  220. #define LOCAL_FLOATSIZE     sizeof(float)
  221.  
  222. /* ------------------------------------------------------------------ */
  223. /* 2 GLOBAL VARIABLES (int vjv and char sj[]) provide a simple
  224. * debugging scheme. Debugging is turned on and off via calls to 
  225. * setjj and setnojj. These globals and functions are found in vgp.c.
  226. * 
  227. * If the debug feature is no longer needed, delete all these, and
  228. * all statements that refer to xzj,sjs, and vjv from the source
  229. *
  230. */
  231.  
  232. extern int         vjv;             /* debugger switch */
  233. extern char     sjs[];         /* contains the debug/error message */
  234.  
  235. /* zj just prints out the contents of the text buffer sjs. */
  236. /* sjs contains debugging messages when debug is on */
  237. /* for the Mac, replace define zj to be any print msg routine */
  238. /* for printf and fprintf - there should be some Mac equivalent */
  239.  
  240. #ifdef MAC
  241. #define printf
  242. #define fprintf
  243. #define zj
  244. #else
  245. #define zj         fprintf(stderr,"%s",sjs) 
  246. #endif
  247.  
  248. /* Macros for returning null, -1 or no value with a message */
  249.  
  250. #define FAIL -1
  251. #define RTNULL(ss) { sprintf(sjs,"@%s\n",ss); zj; return(NULL); }
  252. #define RTNEG(ss) { sprintf(sjs,"@%s\n",ss); zj; return(FAIL); }
  253. #define RT(ss) { sprintf(sjs,"@%s\n",ss); zj; return; }
  254.  
  255. /* .................................................................. */
  256. /* Private data structures. Unlikely to be of interest to applications */
  257. /* 
  258. * These are just typedefs. Actual vfile_ts are declared PRIVATE and
  259. * are not accessible by applications. However, you may change VFILEMAX
  260. * to allow however many files to be opened.
  261. *
  262. * These are memory-resident copies of the tag-refs of the vgroups
  263. * and vdatas for each file that is opened.
  264. * 
  265. */
  266.  
  267. /* this is a memory copy of a vs tag/ref found in the file */
  268. typedef struct vg_instance_struct {
  269.     int     ref;            /* ref # of this vgroup in the file */
  270.     int     nattach;        /* # of current attachs to this vgroup */
  271.     int     nentries;    /* # of entries in that vgroup initially */
  272.     VGROUP *vg;            /* points to the vg when it is attached */
  273. struct vg_instance_struct * next;
  274. }    vginstance_t; 
  275.  
  276. /* this is a memory copy of a vs tag/ref found in the file */
  277. typedef struct vs_instance_struct {
  278.     int    ref;            /* ref # of this vdata in the file */
  279.     int    nattach;        /* # of current attachs to this vdata */
  280.     int    nvertices;    /* # of elements in that vdata initially */
  281.     VDATA    * vs;         /* points to the vdata when it is attached */
  282.     struct vs_instance_struct * next;
  283. }    vsinstance_t; 
  284.  
  285. /* each vfile_t maintains 2 linked lists: one of vgs and one of vdatas
  286. * that already exist or are just created for a given file.  */
  287.  
  288. typedef struct vfiledir_struct {
  289.     DF            * f;
  290.  
  291.    int                vgtabn;                /* # of vg entries in vgtab so far */
  292.     vginstance_t    vgtab;                /* start of vg linked list */
  293.    vginstance_t    *vgtabtail;             /* its tail end */
  294.  
  295.    int                vstabn;                /* # of vs entries in vstab so far */
  296.     vsinstance_t    vstab;                /* start of vs linked list */
  297.    vsinstance_t    *vstabtail;            /* its tail end */
  298. } vfile_t;
  299.  
  300. /* .................................................................. */
  301. #define VSET_VERSION 2                    /* DO NOT CHANGE!! */
  302.  
  303. #ifdef MAC
  304. #include "vset-prototypes.h"
  305. #include <String.h>
  306. #include <ctype.h>
  307. #endif
  308.  
  309. /* 
  310. * DFopen and DFclose are redefined to perform additional work, 
  311. * ie Vset data structure initialization and clean-up.
  312. * Does not affect usage by other HDF interfaces.
  313. */
  314.  
  315. #define DFopen  DFvsetopen
  316. #define DFclose DFvsetclose
  317.  
  318.